Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
DhcpPool Class Reference

DhcpPool holds and manipulates the DHCP pool on the DHCP server. More...

Public Member Functions

string getDhcpPoolName ()
 Returns the name of this pool. More...
 
ip getNetworkAddress ()
 Returns the network address of this pool. More...
 
void setNetworkMask (ip, ip)
 Sets the network address for this pool. More...
 
ip getSubnetMask ()
 Returns the subnet mask of this pool. More...
 
void setDefaultRouter (ip)
 Sets the default router address. More...
 
ip getDefaultRouter ()
 Returns the default router IP address. More...
 
DhcpPoolLease getLeaseAt (int)
 Returns the DHCP lease at the specified index. More...
 
void setStartIp (ip)
 Sets the start IP address for this pool. More...
 
void setNextAvailableIpAddress (ip)
 
void setEndIp (ip)
 Sets the end IP address for this pool. More...
 
void setNetworkAddress (ip)
 
ip getStartIp ()
 Returns the start IP address of this pool. More...
 
ip getEndIp ()
 Returns the end IP address of this pool. More...
 
void setDnsServerIp (ip)
 Sets the DNS server IP address. More...
 
ip getDnsServerIp ()
 Returns the DNS server IP address. More...
 
string getDomainName ()
 Returns the domain name. More...
 
int getMaxUsers ()
 Returns the maximum number of users. More...
 
void setMaxUsers (int)
 Set max users. More...
 
ip getTftpAddress ()
 Returns the IP address of the TFTP server. More...
 
ip getWlcAddress ()
 

Detailed Description

DhcpPool holds and manipulates the DHCP pool on the DHCP server.

Member Function Documentation

◆ getDefaultRouter()

ip DhcpPool::getDefaultRouter ( )

Returns the default router IP address.

Returns
ip, the default router IP address.

◆ getDhcpPoolName()

string DhcpPool::getDhcpPoolName ( )

Returns the name of this pool.

Returns
string, the name of this pool.

◆ getDnsServerIp()

ip DhcpPool::getDnsServerIp ( )

Returns the DNS server IP address.

Returns
ip, the DNS server IP address.

◆ getDomainName()

string DhcpPool::getDomainName ( )

Returns the domain name.

Returns
string, the domain name.

◆ getEndIp()

ip DhcpPool::getEndIp ( )

Returns the end IP address of this pool.

Returns
ip, the end IP address of this pool.

◆ getLeaseAt()

DhcpPoolLease DhcpPool::getLeaseAt ( int  )

Returns the DHCP lease at the specified index.

Parameters
index,theindex of the DHCP lease of interest.
Returns
DhcpPoolLease, the DhcpPoolLease object at the specified index.

◆ getMaxUsers()

int DhcpPool::getMaxUsers ( )

Returns the maximum number of users.

Returns
int, the maximum number of users.

◆ getNetworkAddress()

ip DhcpPool::getNetworkAddress ( )

Returns the network address of this pool.

Returns
ip, the network address of this pool.

◆ getStartIp()

ip DhcpPool::getStartIp ( )

Returns the start IP address of this pool.

Returns
ip, the start IP address of this pool.

◆ getSubnetMask()

ip DhcpPool::getSubnetMask ( )

Returns the subnet mask of this pool.

Returns
ip, the subnet mask of this pool.

◆ getTftpAddress()

ip DhcpPool::getTftpAddress ( )

Returns the IP address of the TFTP server.

Returns
ip, the IP address of the TFTP server.

◆ getWlcAddress()

ip DhcpPool::getWlcAddress ( )

◆ setDefaultRouter()

void DhcpPool::setDefaultRouter ( ip  )

Sets the default router address.

Parameters
ipAddress,theIP address of the default router.

◆ setDnsServerIp()

void DhcpPool::setDnsServerIp ( ip  )

Sets the DNS server IP address.

Parameters
ipAddress,theDNS server IP address.

◆ setEndIp()

void DhcpPool::setEndIp ( ip  )

Sets the end IP address for this pool.

Parameters
ipAddress,theend IP address for this pool.

◆ setMaxUsers()

void DhcpPool::setMaxUsers ( int  )

Set max users.

Parameters
max,themaximum number of users.

◆ setNetworkAddress()

void DhcpPool::setNetworkAddress ( ip  )

◆ setNetworkMask()

void DhcpPool::setNetworkMask ( ip  ,
ip   
)

Sets the network address for this pool.

Parameters
network,thenetwork address for this pool.
mask,thesubnet mask for this pool.

◆ setNextAvailableIpAddress()

void DhcpPool::setNextAvailableIpAddress ( ip  )

◆ setStartIp()

void DhcpPool::setStartIp ( ip  )

Sets the start IP address for this pool.

Parameters
ipAddress,thestart IP address for this pool.

The documentation for this class was generated from the following file: